Skip to main content

GetUserContentExport

A GET request that retrieves an existing user content export. The endpoint is https://api.aware.work/external/search/v1/user-content-exports/{exportId}.

Access​

To access this operation, your API token must have one of the following permissions:

For more information, see the API token documentation.

Request Format​

Parameters​

The only parameter included in this request is a path parameter, which should be set to the exportId of the user content export you wish to retrieve. If you do not have an ID, you can query QueryUserContentExports, filtering on the necessary information.

Query​

Here is a sample request that can be used to retrieve a user content export with the ID of 5e1177db-39c2-ed17-1195-b2e50c242cd0:

curl -X GET --location "https://api.aware.work/external/search/v1/user-content-exports/5e1177db-39c2-ed17-1195-b2e50c242cd0" \
    -H "X-Aware-Api-Key: ${API_TOKEN}"

Response Format​

If your request was successfully executed, the endpoint will return an HTTP 200 status and a response similar to the one below:

{
  "exportId": "a1359bab-7c9b-cf58-d5aa-f853779868a9",
  "exportCriteria": {
    "exportUserEmail": "john.doe@example.com",
    "exportContentStartTime": "2024-03-01T00:00:00+00:00",
    "exportContentEndTime": "2024-03-03T23:59:59+00:00",
    "exportFormat": "Json"
  },
  "exportStatus": "Completed",
  "exportStartedTime": "2024-03-11T19:46:25.395707",
  "exportCompletedTime": "2024-03-11T20:05:52.3272034",
  "exportFileParts": [
    "idf-sf-ff5a8bf5-8063-45fc-81a7-a90b01334161\\80618b3a-f2f6-4aec-9877-cc5ff0a7f806"
  ]
}